Skip to content

refactor: centralize common schema checks in ModelUtils#23608

Open
Mattias-Sehlstedt wants to merge 1 commit intoOpenAPITools:masterfrom
Mattias-Sehlstedt:schema-utils
Open

refactor: centralize common schema checks in ModelUtils#23608
Mattias-Sehlstedt wants to merge 1 commit intoOpenAPITools:masterfrom
Mattias-Sehlstedt:schema-utils

Conversation

@Mattias-Sehlstedt
Copy link
Copy Markdown
Contributor

@Mattias-Sehlstedt Mattias-Sehlstedt commented Apr 23, 2026

Adds a SchemaUtils class with common schema operations. Improves readability and makes the if-cases easier to read as the method name clearly highlights what is checked.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Centralizes schema checks in ModelUtils and refactors generators/utilities to use them for consistent, clearer logic. No functional changes intended.

  • Refactors
    • Added helpers in org.openapitools.codegen.utils.ModelUtils: hasAllOf, hasOneOf, hasAnyOf, hasProperties, hasEnum, isObjectTypeOAS30.
    • Replaced inline checks across DefaultCodegen, InlineModelResolver, OpenAPINormalizer, language codegens (AbstractJavaCodegen, AbstractPhpCodegen, AbstractPythonCodegen, AbstractPythonPydanticV1Codegen, CppHttplibServerCodegen, CppRestSdkClientCodegen), and OpenApiSchemaValidations.
    • C++ server: added local isNestedObject and standardized oneOf/anyOf handling using std::variant.

Written for commit 79df5f5. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 12 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/OpenAPINormalizer.java">

<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/OpenAPINormalizer.java:1113">
P1: Complex composed schemas can skip property normalization because this condition checks `hasEnum` instead of `hasProperties`.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the schema-utils branch 3 times, most recently from ffe95a6 to 5ba7970 Compare April 23, 2026 19:57
@wing328
Copy link
Copy Markdown
Member

wing328 commented Apr 24, 2026

thanks for the PR for refactoring the code.

what about putting these functions in ModelUtils instead as some functions in ModelUtils already doing something similar?

@Mattias-Sehlstedt Mattias-Sehlstedt changed the title refactor: add a schema utils class with common schema operations refactor: centralize common schema checks in ModelUtils Apr 24, 2026
@Mattias-Sehlstedt
Copy link
Copy Markdown
Contributor Author

@wing328 Good suggestion, had missed that they do basically the same. I have instead moved everything into ModelUtils and utilized it in relevant places.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants